vcProductFeed

A product feed is an abstract object that informs Visual Components about a product that is ready for transport or the next process. vcProductFeed is the owner of a feed and has full control over the feed.

See in: Overview

Module: vcProcessModel

Parent: vcObject

Children -

Referenced by: vcProductMatcher.PendingFeeds, vcProductNeedFeedMatch.MatchedFeed

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
IsCancellable	Boolean	R	Gets if the feed can be cancelled. Internal feeds cannot be cancelled.
NextProcessFlowOptions	list	R	Gets the list of options (in priority order) to be matched to possible needs.
NextProcessGroupId	String	R	Gets the name of the target process. See more Exceptions: ValueError: When feed has multiple destination processes. Use NextProcessFlowOptions instead.
Product	vcProduct	R	Gets the product instance in the simulation.
SourceNode	vcTransportNode	R	Gets the current location of the product instance.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
new	vcProductFeed	vcProduct product, vcTransportNode node, String OR None nextProcessGroupId	Creates a new vcProductFeed object and returns the new feed. Creates new product type and assigns it to the given flow group. The name must be unique. See more Parameters: product (vcProduct): The product to attach the feed to. node (vcTransportNode): The source node of the feed. Optional: nextProcessGroupId (str): Name of the target process. If not defined, the feed can be matched with any process that has a need with the matching product and a valid transport solution, including an existing route and necessary links. Returns: vcProductFeed: The created feed.
new	vcProductFeed	vcProduct product, vcTransportNode node, List[vcFeedOptionFlowInfo] options	Creates a new vcProductFeed object and returns the new feed. Creates new product type and assigns it to the given flow group. The name must be unique. See more Parameters: product (vcProduct): The product to attach the feed to. node (vcTransportNode): The source node of the feed. options (List[vcFeedOptionFlowInfo]): List of options defining a flow group. Returns: vcProductFeed: The created feed.
setOnMatched	None	Callable OR None function	Sets the callback function that is called when the feed is matched with a need. See more Parameters: function (callable): The function to call when the event is triggered.
tryCancel	Boolean	None	Cancels a match and removes the feed from vcProductMatcher. A match cannot be cancelled after the match has been finalized. See more Returns: bool: True if the match was cancelled or the feed was not found in the product matcher. False otherwise. Exceptions: ValueError: When the feed is not cancellable due to being handled internally.